Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / detritus-client / structures / BaseGuild

Class BaseGuild

extends BaseStructureclass BaseStructuredetritus-client/structures/BaseStructure

Defined in guild

Base Guild Structure

Constructor

constructor(
client: ShardClientclass ShardClientdetritus-client/ShardClient,
data?: BaseStructureDatainterface BaseStructureDatadetritus-client/structures/BaseStructureData,
isClone?: boolean
)

Properties

_keys = BaseSetclass BaseSetdetritus-utils/BaseSet<string>[src]
features = BaseSetclass BaseSetdetritus-utils/BaseSet<string>[src]

Methods

get createdAt(): Dateexternal Date[src]
iconUrlFormat(format?: null | string, query?: UrlQuerytype UrlQuerydetritus-client/utils/UrlQuery): null | string[src]
widgetImageUrlFormat(query?: UrlQuerytype UrlQuerydetritus-client/utils/UrlQuery): string[src]
widgetUrlFormat(options: RouteWidgetinterface RouteWidgetdetritus-client-rest/RequestTypes/RouteWidget = {}): string[src]
ack(): Promise<any>external Promise[src]
addMember(
userId: string,
options: AddGuildMemberinterface AddGuildMemberdetritus-client-rest/RequestTypes/AddGuildMember
): Promise<any>external Promise[src]
addMemberRole(userId: string, roleId: string): Promise<any>external Promise[src]
beginPrune(options: BeginGuildPruneinterface BeginGuildPrunedetritus-client-rest/RequestTypes/BeginGuildPrune = {}): Promise<any>external Promise[src]
createBan(
userId: string,
options: CreateGuildBaninterface CreateGuildBandetritus-client-rest/RequestTypes/CreateGuildBan
): Promise<any>external Promise[src]
createChannel(
options: CreateGuildChannelinterface CreateGuildChanneldetritus-client-rest/CreateGuildChannel
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
createEmoji(
options: CreateGuildEmojiinterface CreateGuildEmojidetritus-client-rest/RequestTypes/CreateGuildEmoji
): Promise<Emojiclass Emojidetritus-client/structures/Emoji>external Promise[src]
createIntegration(
options: CreateGuildIntegrationinterface CreateGuildIntegrationdetritus-client-rest/RequestTypes/CreateGuildIntegration
): Promise<any>external Promise[src]
createRole(
options: CreateGuildRoleinterface CreateGuildRoledetritus-client-rest/CreateGuildRole
): Promise<Roleclass Roledetritus-client/structures/Role>external Promise[src]
createSticker(
options: CreateGuildStickerinterface CreateGuildStickerdetritus-client-rest/RequestTypes/CreateGuildSticker
): Promise<Stickerclass Stickerdetritus-client/structures/Sticker>external Promise[src]
createTemplate(
options: CreateGuildTemplateinterface CreateGuildTemplatedetritus-client-rest/RequestTypes/CreateGuildTemplate
): Promise<Templateclass Templatedetritus-client/structures/Template>external Promise[src]
delete(): Promise<any>external Promise[src]
deleteChannel(
channelId: string,
options: DeleteChannelinterface DeleteChanneldetritus-client-rest/RequestTypes/DeleteChannel = {}
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
deleteEmoji(
emojiId: string,
options: DeleteGuildEmojiinterface DeleteGuildEmojidetritus-client-rest/RequestTypes/DeleteGuildEmoji = {}
): Promise<any>external Promise[src]
deleteIntegration(
integrationId: string,
options: DeleteGuildIntegrationinterface DeleteGuildIntegrationdetritus-client-rest/RequestTypes/DeleteGuildIntegration = {}
): Promise<any>external Promise[src]
deletePremiumSubscription(subscriptionId: string): Promise<any>external Promise[src]
deleteRole(
roleId: string,
options: DeleteGuildRoleinterface DeleteGuildRoledetritus-client-rest/RequestTypes/DeleteGuildRole = {}
): Promise<any>external Promise[src]
deleteSticker(stickerId: string): Promise<any>external Promise[src]
deleteTemplate(templateId: string): Promise<any>external Promise[src]
edit(options: EditGuildinterface EditGuilddetritus-client-rest/RequestTypes/EditGuild): Promise<Guildclass Guilddetritus-client/structures/Guild>external Promise[src]
editChannel(
channelId: string,
options: EditChannelinterface EditChanneldetritus-client-rest/RequestTypes/EditChannel
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
editChannelPositions(
channels: EditGuildChannelsinterface EditGuildChannelsdetritus-client-rest/RequestTypes/EditGuildChannels,
options: EditGuildChannelsExtrainterface EditGuildChannelsExtradetritus-client-rest/RequestTypes/EditGuildChannelsExtra = {}
): Promise<any>external Promise[src]
editEmbed(options: EditGuildEmbedinterface EditGuildEmbeddetritus-client-rest/RequestTypes/EditGuildEmbed): Promise<any>external Promise[src]
editEmoji(
emojiId: string,
options: EditGuildEmojiinterface EditGuildEmojidetritus-client-rest/RequestTypes/EditGuildEmoji
): Promise<Emojiclass Emojidetritus-client/structures/Emoji>external Promise[src]
editIntegration(
integrationId: string,
options: EditGuildIntegrationinterface EditGuildIntegrationdetritus-client-rest/RequestTypes/EditGuildIntegration
): Promise<any>external Promise[src]
editMember(
userId: string,
options: EditGuildMemberinterface EditGuildMemberdetritus-client-rest/RequestTypes/EditGuildMember
): Promise<any>external Promise[src]
editMfaLevel(options: EditGuildMfaLevelinterface EditGuildMfaLeveldetritus-client-rest/RequestTypes/EditGuildMfaLevel): Promise<any>external Promise[src]
editNick(
nick: string,
options: EditGuildNickinterface EditGuildNickdetritus-client-rest/RequestTypes/EditGuildNick = {}
): Promise<any>external Promise[src]
editRole(
roleId: string,
options: EditGuildRoleinterface EditGuildRoledetritus-client-rest/RequestTypes/EditGuildRole
): Promise<Roleclass Roledetritus-client/structures/Role>external Promise[src]
editRolePositions(
roles: EditGuildRolePositionsinterface EditGuildRolePositionsdetritus-client-rest/RequestTypes/EditGuildRolePositions,
options: EditGuildRolePositionsExtrainterface EditGuildRolePositionsExtradetritus-client-rest/RequestTypes/EditGuildRolePositionsExtra = {}
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Roleclass Roledetritus-client/structures/Role>>external Promise[src]
editSticker(
stickerId: string,
options: EditGuildStickerinterface EditGuildStickerdetritus-client-rest/RequestTypes/EditGuildSticker = {}
): Promise<Stickerclass Stickerdetritus-client/structures/Sticker>external Promise[src]
editVanityUrl(
code: string,
options: EditGuildVanityinterface EditGuildVanitydetritus-client-rest/RequestTypes/EditGuildVanity = {}
): Promise<any>external Promise[src]
editVoiceState(
userId: string,
options: EditGuildVoiceStateinterface EditGuildVoiceStatedetritus-client-rest/RequestTypes/EditGuildVoiceState
): Promise<any>external Promise[src]
fetchApplications(channelId?: string): Promise<any>external Promise[src]
fetchAuditLogs(
options: FetchGuildAuditLogsinterface FetchGuildAuditLogsdetritus-client-rest/RequestTypes/FetchGuildAuditLogs
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, AuditLogclass AuditLogdetritus-client/structures/AuditLog>>external Promise[src]
fetchBans(): Promise<FetchGuildBansinterface FetchGuildBansdetritus-client/rest/RestResponses/FetchGuildBans>external Promise[src]
fetchChannels(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>>external Promise[src]
fetchEmbed(): Promise<any>external Promise[src]
fetchEmoji(emojiId: string): Promise<Emojiclass Emojidetritus-client/structures/Emoji>external Promise[src]
fetchEmojis(): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Emojiclass Emojidetritus-client/structures/Emoji>>external Promise[src]
fetchInvites(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Inviteclass Invitedetritus-client/structures/Invite>>external Promise[src]
fetchIntegrations(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Integrationclass Integrationdetritus-client/structures/Integration>>external Promise[src]
fetchMember(userId: string): Promise<Memberclass Memberdetritus-client/structures/Member>external Promise[src]
fetchMembers(
options: FetchGuildMembersinterface FetchGuildMembersdetritus-client-rest/RequestTypes/FetchGuildMembers
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Memberclass Memberdetritus-client/structures/Member>>external Promise[src]
fetchMembersSearch(
options: FetchGuildMembersSearchinterface FetchGuildMembersSearchdetritus-client-rest/RequestTypes/FetchGuildMembersSearch
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Memberclass Memberdetritus-client/structures/Member>>external Promise[src]
fetchPremiumSubscriptions(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, PremiumSubscriptionclass PremiumSubscriptiondetritus-client/structures/PremiumSubscription>>external Promise[src]
fetchPruneCount(): Promise<any>external Promise[src]
fetchRoles(): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Roleclass Roledetritus-client/structures/Role>>external Promise[src]
fetchSticker(stickerId: string): Promise<Stickerclass Stickerdetritus-client/structures/Sticker>external Promise[src]
fetchStickers(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Stickerclass Stickerdetritus-client/structures/Sticker>>external Promise[src]
fetchTemplates(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Templateclass Templatedetritus-client/structures/Template>>external Promise[src]
fetchVanityUrl(): Promise<any>external Promise[src]
fetchVoiceRegions(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, VoiceRegionclass VoiceRegiondetritus-client/structures/VoiceRegion>>external Promise[src]
fetchWebhooks(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Webhookclass Webhookdetritus-client/structures/Webhook>>external Promise[src]
fetchWidget(): Promise<any>external Promise[src]
fetchWidgetJson(): Promise<any>external Promise[src]
fetchWidgetPng(
options: FetchGuildWidgetPnginterface FetchGuildWidgetPngdetritus-client-rest/RequestTypes/FetchGuildWidgetPng = {}
): Promise<any>external Promise[src]
join(options: JoinGuildinterface JoinGuilddetritus-client-rest/RequestTypes/JoinGuild): Promise<any>external Promise[src]
leave(): Promise<any>external Promise[src]
removeBan(
userId: string,
options: RemoveGuildBaninterface RemoveGuildBandetritus-client-rest/RequestTypes/RemoveGuildBan = {}
): Promise<any>external Promise[src]
removeMember(
userId: string,
options: RemoveGuildMemberinterface RemoveGuildMemberdetritus-client-rest/RequestTypes/RemoveGuildMember = {}
): Promise<any>external Promise[src]
removeMemberRole(
userId: string,
roleId: string,
options: RemoveGuildBaninterface RemoveGuildBandetritus-client-rest/RequestTypes/RemoveGuildBan = {}
): Promise<any>external Promise[src]
requestMembers(
options: {
limit?: number,
presences?: boolean,
query: string,
timeout?: number,
userIds?: Array<string>external Array
}
): Promise<__type>external Promise[src]
search(
options: SearchOptionsinterface SearchOptionsdetritus-client-rest/RequestTypes/SearchOptions,
retry?: boolean
): Promise<any>external Promise[src]
syncIntegration(integrationId: string): Promise<any>external Promise[src]
mergeValue(key: string, value: any): void[src]